home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 1 / LIGHT-ROM 1 (Amiga Library Services)(1994).iso / ffdisks / d916.lha / Rego / Rego.Doc < prev    next >
Text File  |  1993-10-04  |  15KB  |  340 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                              Registration Manager
  9.                                       
  10.                                     v 1.01
  11.  
  12.  
  13.                                KickStart 2.0 or
  14.                                higher required.
  15.  
  16.  
  17.  
  18.  
  19.                                 Shareware ($15)
  20.                                 Paul  Mclachlan
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                                 Copyright ©1993
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.     INTRODUCTION:
  38.  
  39.         Registration Manager (or Rego, for short) is a small `address book'
  40.         program, which provides added support for program registrations,
  41.         ie:  for shareware.  This was, at least, it's original intention.
  42.         Of course, it is capable of much more than shareware registrations
  43.         - if you run any sort of club or magazine, in which people can
  44.         register to more than one item, then this program is for you.  It
  45.         provides for multi-registrations - so when people register this
  46.         program to me (and you will... won't you?), as well as my other
  47.         major program, AII, then I don't have any major hassles putting
  48.         them in the database for both.  Pretty clever, huh?
  49.  
  50.     FEATURES:
  51.  
  52.         Registration Manager keeps the following information about each
  53.         person in the database:
  54.  
  55.             Name, Street Address, Suburb/City/Locale, State, Zip/PostCode,
  56.             Phone Number, Country, an optional comment line, and of course,
  57.             the items that they've registered to.
  58.  
  59.         It supports searching, and this is done through AmigaDOS pattern
  60.         matching (power in a system you already know how to use) - and it
  61.         can search Name, phone Number and registered items.  If according
  62.         to the pattern that you specify, there is more than one person who
  63.         fits the bill, you can single step through them all easily.
  64.  
  65.     DOCUMENTATION OF FEATURES:
  66.  
  67.         OK, now we're into the nitty gritty.  This is intended as a
  68.         reference, not as something to read all through.  First I have a
  69.         real quick list of some features that are not immediately apparent,
  70.         and then an indepth explanation of everything in the program.
  71.  
  72.         KEYS:
  73.  
  74.             There are several keyboard shortcuts that allow you to do
  75.             things within the program quickly without reaching for that
  76.             pesky mouse (always hated the thing anyway... mine doesn't work
  77.             too well...)
  78.  
  79.                 HELP    -   Hit the help key for a list of all the other
  80.                             keys that work in the program.
  81.  
  82.                 ARROWS  -   Use the arrow keys to step through the records.
  83.                             If you hold down SHIFT and hit an arrow you
  84.                             will go to the beginning or end of the records.
  85.                             Left & Up go towards the beginning, while Down
  86.                             & Right go towards the end.
  87.  
  88.                 ESCAPE  -   Same as the close gadget: saves and quits.
  89.  
  90.                 DELETE  -   I mean the little KeyPad one, on the `.', I
  91.                             don't like the other one (next to help) since
  92.                             it's too close to HELP, and some people might
  93.                             hit it by accident.  Deletes the current
  94.                             record.  (Same as gadget)
  95.  
  96.                 INSERT  -   On the keypad too, on the `0' key, its marked.
  97.                             Adds a new record to the database.
  98.  
  99.                 TAB     -   Activates the Name gadget to write into.  I
  100.                             HATE using the mouse to activate a string
  101.                             gadget so I can go back to the keyboard again -
  102.                             so here is a shortcut.  Using SHIFT with this
  103.                             key will activate the little gadget under the
  104.                             registration manager listview.  This is the
  105.                             only gadget that cannot be activated by
  106.                             starting on one and <RETURN>ing your way
  107.                             through.
  108.  
  109.             Gee... that wasn't very concise, was it?  Oh well... sorry.
  110.             You sorta need to know those keys but (especially the arrows..
  111.             there isn't another way to do that in the program).  Wow...
  112.             here I am writing these docs, and I've got the program running
  113.             in the background (so I don't miss anything)... anyway.. for
  114.             those keys above I was looking at the help screen (again - so I
  115.             didn't miss any - It's not because I don't know how to use my
  116.             own programs, Chris...).. anyway, I then went on to start the
  117.             next section of the docs, and clicked the little help window
  118.             close gadget... nothing happened.  Program worked fine in the
  119.             background... I've just got this help window sitting on my
  120.             WorkBench screen... you're lucky I found that one.. that would
  121.             have been annoying :)
  122.  
  123.             OK.. onto the proper sections of the program.
  124.  
  125.         THE MAIN WINDOW
  126.  
  127.             Lets start with the control gadgets:
  128.  
  129.                 NEW:
  130.  
  131.                     Quite predictably, makes a bit of memory, and frees
  132.                     everything up for you to enter a new person into the
  133.                     database.
  134.  
  135.                 DELETE:
  136.  
  137.                     Use this one with care.  This deletes the current
  138.                     person (the one that you're looking ats name and
  139.                     everything).
  140.  
  141.                 SEARCH:
  142.  
  143.                     This brings up the Search Window.  We'll check it out a
  144.                     few pages down.
  145.  
  146.                 WRITE:
  147.  
  148.                     Writes the database to disk "S:RegoData".  This file is
  149.                     also loaded every time the program is started up.  You
  150.                     don't need to click this every time before you quit the
  151.                     program, as quitting the program (via the close gadget)
  152.                     will automatically save the database.
  153.  
  154.             The big box with `Registered' written above it is a ListView
  155.             gadget.  This listview gadget contains all the programs or
  156.             items that the current person is registered to.  The use of
  157.             the listview is as follows:
  158.  
  159.                 To add a new item to the listview gadget, simply click (or
  160.                 SHIFT-TAB) into the string gadget below the listview, and
  161.                 type in the name of the item to add, and hit return.
  162.  
  163.                 To modify or change an item in the listview gadget, click
  164.                 on its name, and modify its name in the string gadget
  165.                 below, then hit return.
  166.  
  167.                 To delete an item in the listview, click on its name, and
  168.                 then, in the string gadget below, delete the name, and hit
  169.                 return.  This deletion can be quickly accomplished by
  170.                 putting the cursor at the end of the string, and hitting
  171.                 SHIFT-BACKSPACE.
  172.  
  173.             The other string gadgets `scattered' around the window contain
  174.             information about the user.  Entering this information is as
  175.             easy as any string gadget.  Simply click on the gadget and
  176.             change it.  If you hit TAB, then you will be taken to the Name
  177.             gadget, and then when you hit return you will be taken down
  178.             through the other gadgets, allowing you to easily enter new
  179.             records (without reaching for that mouse again).
  180.  
  181.             A few notes on these.  The `Locale' is intended as a generic
  182.             for a City/Suburb or whatever.  Here in Australia, we call
  183.             them suburbs, but I know that in America they are called `City'
  184.             and so I have opted for the general.  In order to present an
  185.             example that I believe no-one in the world wouldn't know about,
  186.             "Beverly Hills" is a locale, although so could "LA" be a
  187.             locale, depending on your preference, large or small scale.
  188.             For an example closer to home, "Blakehurst" is a suburb, on the
  189.             small scale of Locale, while "Sydney" is a city, on the larger
  190.             scale.  Aww... who cares.  Do whatever you want here.
  191.  
  192.             The same on `Zip'.  We call them Post Codes here, but the
  193.             Americans call it a Zip Code.  Besides, Post Code didn't fit,
  194.             and Zip did :)  (Try 90120 for an example... one guess where
  195.             that's from :)
  196.  
  197.             Of course, it doesn't matter to me or the program how you use
  198.             these gadgets.  They are all just strings as far as the program
  199.             is concerned.  If you want, replace Phone with company, for
  200.             instance, and put the phone number somewhere else.  Then you
  201.             can search for people depending on what company they work for.
  202.             Alternatively, you might put the company they work for in the
  203.             listview, allow people to work for multiple companies (??).
  204.  
  205.         THE SEARCH WINDOW:
  206.  
  207.             In the search window is a cycle gadget, a string gadget and a
  208.             little button to begin the search.
  209.  
  210.             The Cycle gadget determines which field to search.  It can be
  211.             Name, Phone number, or an item in the registration list.  I
  212.             suppose I should also include a search through the `Comment'...
  213.             oh well.. see the next version.
  214.  
  215.             The string gadget "Search String" is the string to search for.
  216.             It uses AmigaDOS searching patterns.  So if you want a name
  217.             that contains "Paul" then specify "#?Paul#?" in the search
  218.             string.  The you'll get the first person who has the string
  219.             Paul in his/her name.  It allows for much more complicated
  220.             searches than would normally be possible under a straight
  221.             keyword.
  222.  
  223.             The begin search button finds the *next* record that fits the
  224.             pattern specified.  If there are multiple records that fit the
  225.             pattern, you can jump through them all by repeatedly clicking
  226.             this button.
  227.  
  228.             Umm, say I search for all registered users of `Rego', then I
  229.             put `Rego' in the search string, click the cycle gadget through
  230.             to `Registration', and click begin search.  The first
  231.             registered user will appear.  Now I can modify that user
  232.             however I want (leaving the search window there - if I want),
  233.             and when I'm ready to find the next guy who's registered, then
  234.             I can click Begin Search again.  When I've gone around all the
  235.             people who've registered it will just wrap around them and
  236.             start again.
  237.  
  238.             If you click Begin search and nothing happens, this is because:
  239.                 i)  The user currently displayed is the one and only user
  240.                     that fits the pattern.
  241.                 ii) There are no users that fit the pattern.
  242.  
  243.             Fun huh?
  244.  
  245.     AFTERWORD:
  246.  
  247.         Have you noticed that I've finished all the features in this
  248.         program?  Hmmm...
  249.  
  250.         OK - This program IS shareware, which means that I want to be paid
  251.         for spending all my time making it work.  Sure, I'm gonna use it,
  252.         but it wouldn't be this good if it was just for me.  (I'll show you
  253.         some of the programs I've written just for me, if you want :)
  254.  
  255.         So, send $15 to me at this address (please?):
  256.  
  257.                     Paul Mclachlan
  258.                     60 Hatfield street
  259.                     Blakehurst, 2221
  260.                     AUSTRALIA
  261.  
  262.         If you live in Australia, send me Australian Dollars - otherwise,
  263.         send American (I believe that these are the easiest to come across
  264.         - and easy for me to cash as well).
  265.  
  266.         Alternatively, just send me a disk with some cool programs you've
  267.         written on it (with source if you can fit it) - and we'll call it a
  268.         swap.
  269.  
  270.         If you want the source to this program - then this can be
  271.         organised.. write to me and tell me why you want it and I'll send
  272.         you out a copy (unless your reason is REALLY lame :)  Umm, if you
  273.         do this you'd better register + about $3 extra for the disk to send
  274.         to you, and also the postage.  I'll also pack the disk full of
  275.         anything else I've written (no extra weight - might as well send it
  276.         across), etc etc.
  277.  
  278.     FOR THOSE NOT IN THE KNOW:
  279.  
  280.         These stupid little :)'s is a grin.  Its a way of representing a
  281.         well, smile that you would use in conversation.  Quite a trend
  282.         throughout the modem world - but anyway.
  283.  
  284.     SUPPORT:
  285.  
  286.         If you've registered (or registering) and you find a bug, send me
  287.         out everything you can think of about the bug (including what sort
  288.         of system you're running on), and I'll fix it.  If you haven't
  289.         registered, send it anyway, but if its too hard to understand what
  290.         the problem is I probably won't spend too much time trying to work
  291.         it out.
  292.  
  293.         Umm.. you can also call my board to get the latest version or
  294.         whatever, on:
  295.  
  296.             Intl-61-2-5430572
  297.  
  298.         All 2400->14.4k speeds, 24 hours, etc etc.
  299.  
  300.     FUTURE:
  301.  
  302.         In the future, I'd really like to put in automatic sorting of the
  303.         users in the database.  This was going to be in this version but it
  304.         really stuffed up well, so I thought it was better to release this
  305.         now, then making you wait 6 months for the version with very little
  306.         different.  I've got to do my final exams in about 3 months, and so
  307.         will be doing less than zero programming.  If any of you people out
  308.         there have any wonderful ideas for the improvement of this program,
  309.         feel free to send them in to me.  I'm always looking for ways to
  310.         improve any of my programs.
  311.  
  312.  
  313.     FINALLY:
  314.  
  315.                         Registration Manager facts:
  316.  
  317.                      Source Code Size:           66575
  318.                      Executable Size:            22112
  319.                      Documentation Size:         14773
  320.                      Total Size of Distribution: 37851
  321.  
  322.  
  323.                 This program was created with the help of:
  324.                       (Listed from least use to most)
  325.  
  326.                          Iff2Src by J.Tyberghein.
  327.                      GadToolsBox by Jan ven den Baard
  328.                           Cygnus Editor release 2
  329.                                 SAS/C v6.3
  330.                        Everyone's favourite computer
  331.  
  332.  
  333.  
  334.         Apart from the source generated by Iff2Src, GadToolsBox, the Amiga
  335.         Includes and the linked code from the standard Amiga libraries,
  336.         this code is entirely my own work and is copyrighted as such.
  337.  
  338.  
  339.  
  340.